/*-------------------------------------------------------------------------
 *
 * pg_crc32c.h
 *	  计算 CRC-32C 校验和的例程。
 *
 * CRC-32C 计算的速度对性能有很大影响，因此我们会进行一些特定的实现以获得
 * 每个平台的最佳实现。某些 CPU 架构具有加速 CRC 计算的特殊指令（例如，Intel SSE 4.2），
 * 在其他平台上我们使用使用查找表的 Slicing-by-8 算法。
 *
 * 公开接口由四个宏组成：
 *
 * INIT_CRC32C(crc)
 *		初始化 CRC 累加器
 *
 * COMP_CRC32C(crc, data, len)
 *		将一些（更多）字节累加到 CRC
 *
 * FIN_CRC32C(crc)
 *		完成 CRC 计算
 *
 * EQ_CRC32C(c1, c2)
 *		检查两个 CRC 是否相等。
 *
 * Portions Copyright (c) 1996-2022, PostgreSQL Global Development Group
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 * src/include/port/pg_crc32c.h
 *
 *-------------------------------------------------------------------------
 */
#ifndef PG_CRC32C_H
#define PG_CRC32C_H

#include "port/pg_bswap.h"

typedef uint32 pg_crc32c;

/* INIT 和 EQ 宏对所有实现都是相同的。 */
#define INIT_CRC32C(crc) ((crc) = 0xFFFFFFFF)
#define EQ_CRC32C(c1, c2) ((c1) == (c2))

#if defined(USE_SSE42_CRC32C)
/* 使用 Intel SSE4.2 指令。 */
#define COMP_CRC32C(crc, data, len) \
	((crc) = pg_comp_crc32c_sse42((crc), (data), (len)))
#define FIN_CRC32C(crc) ((crc) ^= 0xFFFFFFFF)

extern pg_crc32c pg_comp_crc32c_sse42(pg_crc32c crc, const void *data, size_t len);

#elif defined(USE_ARMV8_CRC32C)
/* 使用 ARMv8 CRC 扩展指令。 */

#define COMP_CRC32C(crc, data, len)							\
	((crc) = pg_comp_crc32c_armv8((crc), (data), (len)))
#define FIN_CRC32C(crc) ((crc) ^= 0xFFFFFFFF)

extern pg_crc32c pg_comp_crc32c_armv8(pg_crc32c crc, const void *data, size_t len);

#elif defined(USE_SSE42_CRC32C_WITH_RUNTIME_CHECK) || defined(USE_ARMV8_CRC32C_WITH_RUNTIME_CHECK)

/*
 * 使用 Intel SSE 4.2 或 ARMv8 指令，但首先进行运行时检查
 * 以确认它们是否可用。
 */
#define COMP_CRC32C(crc, data, len) \
	((crc) = pg_comp_crc32c((crc), (data), (len)))
#define FIN_CRC32C(crc) ((crc) ^= 0xFFFFFFFF)

extern pg_crc32c pg_comp_crc32c_sb8(pg_crc32c crc, const void *data, size_t len);
extern pg_crc32c (*pg_comp_crc32c) (pg_crc32c crc, const void *data, size_t len);

#ifdef USE_SSE42_CRC32C_WITH_RUNTIME_CHECK
extern pg_crc32c pg_comp_crc32c_sse42(pg_crc32c crc, const void *data, size_t len);
#endif
#ifdef USE_ARMV8_CRC32C_WITH_RUNTIME_CHECK
extern pg_crc32c pg_comp_crc32c_armv8(pg_crc32c crc, const void *data, size_t len);
#endif

#else
/*
 * 使用按 8 切片算法。
 *
 * 在大端系统中，中间值以反向字节顺序保持，以避免在计算期间进行字节交换。FIN_CRC32C 将字节反转为最终顺序。
 */
#define COMP_CRC32C(crc, data, len) \
	((crc) = pg_comp_crc32c_sb8((crc), (data), (len)))
#ifdef WORDS_BIGENDIAN
#define FIN_CRC32C(crc) ((crc) = pg_bswap32(crc) ^ 0xFFFFFFFF)
#else
#define FIN_CRC32C(crc) ((crc) ^= 0xFFFFFFFF)
#endif

extern pg_crc32c pg_comp_crc32c_sb8(pg_crc32c crc, const void *data, size_t len);

#endif

#endif							/* PG_CRC32C_H */
